

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Enterprise Architect Reports [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Create,Create Documents,HTML,HTML Documentation,HTML Report,RTF,RTF Documentation,RTF Report,Report,Report HTML,Report RTF,Report Rich Text Format,Document,Document RTF,Document HTML,Document Exclude Packages,Document Rich Text Format,Document Projects,Document Enterprise Architect Content">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Enterprise Architect Reports</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="crossreferences2.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="rtfdocuments.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_TextIndentedL1"><img src="creating_documents.png" width="199" height="97" border="0" alt="creating_documents"></p>
<p class="p_BodyText"><span class="f_BodyText">Model documentation is essential to realizing the full benefit of Enterprise Architect. Enterprise Architect provides a powerful mechanism for generating high quality, customized documentation directly from your model, in either RTF or HTML format.</span></p>
<p class="p_BodyText"><span class="f_BodyText">There are many ways to specify the Enterprise Architect content being documented. You can:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Document a package and/or its child packages by manually highlighting the package and selecting a documentation control</span></li>
<li><span class="f_Bulletlist1">Specify embedded packages for <a href="includeorexcludeapackagef.htm">exclusion</a> if child packages are recursively documented</span></li>
<li><span class="f_Bulletlist1">Link a package to an RTF document template to simplify generating consistent types of documentation (eg Use Case Reports) using the <a href="saveasdocument.htm">Documents feature</a></span></li>
<li><span class="f_Bulletlist1">Select, group and order packages together in a </span><span class="f_Bulletlist1" style="font-style: italic;">different manner</span><span class="f_Bulletlist1"> from the </span><span class="f_UIControl">Project Browser</span><span class="f_Bulletlist1"> by creating '<a href="virtualdocuments.htm">Virtual' Documents</a>, either linked through a</span><span class="f_BodyText"> master document with headers, footers and contents list, or as separate individual documents.</span></li>
</ul>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">RTF Documentation</span></p>
<p class="p_BodyText"><span class="f_BodyText">Rich text reports are documents produced by Enterprise Architect in Rich Text Format (RTF). </span><span class="f_BodyText">RTF formatting can be modified directly with RTF Style templates to alter the look and feel of generated output. Using MS Word you can further enhance the separate RTF documents output from the model by connecting and interweaving them into a linked <a href="virtualdocuments.htm">master document</a> with headers, footers and contents list.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Enterprise Architect has a fully-featured RTF Document Generator that features:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Powerful WYSIWYG RTF style template editor support</span></li>
<li><span class="f_Bulletlist1">An easy-to-use document generator</span></li>
<li><span class="f_Bulletlist1">An embedded RTF viewer that enables you to view RTF documents generated by Enterprise Architect within Enterprise Architect.</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">For further information, see:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1"><a href="rtfdocuments.htm">RTF Documents</a></span></li>
<li><span class="f_Bulletlist1"><a href="usingmsword.htm">Use MS Word.</a></span></li>
</ul>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">RTF Reports</span></p>
<p class="p_BodyText"><span class="f_BodyText">You can also generate a number of RTF reports on different aspects of your model. See the </span><span class="f_BodyText" style="font-style: italic;"><a href="otherdocuments.htm">Other Documents</a></span><span class="f_BodyText"> topic.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">HTML Documentation</span></p>
<p class="p_BodyText"><span class="f_BodyText">Enterprise Architect </span><span class="f_BodyText">provides automated web-based publishing of models, making it simple to explore large models efficiently on-line. Enterprise Architect </span><span class="f_BodyText">enables the export of an entire model or a single branch of the model to HTML Web pages. You can also create web style templates to customize the HTML output.</span></p>
<p class="p_BodyText"><span class="f_BodyText">For further information, see the </span><span class="f_BodyText" style="font-style: italic;"><a href="htmlreports.htm">HTML Reports</a></span><span class="f_BodyText"> topic.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
